

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>roster_core.config &mdash; Roster Core v0.17 documentation</title>
    
    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../',
        VERSION:     'v0.17',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../../_static/jquery.js"></script>
    <script type="text/javascript" src="../../_static/underscore.js"></script>
    <script type="text/javascript" src="../../_static/doctools.js"></script>
    <link rel="top" title="Roster Core v0.17 documentation" href="../../index.html" />
    <link rel="up" title="Module code" href="../index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../index.html">Roster Core v0.17 documentation</a> &raquo;</li>
          <li><a href="../index.html" accesskey="U">Module code</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <h1>Source code for roster_core.config</h1><div class="highlight"><pre>
<span class="c">#!/usr/bin/python</span>

<span class="c"># Copyright (c) 2009, Purdue University</span>
<span class="c"># All rights reserved.</span>
<span class="c"># </span>
<span class="c"># Redistribution and use in source and binary forms, with or without</span>
<span class="c"># modification, are permitted provided that the following conditions are met:</span>
<span class="c"># </span>
<span class="c"># Redistributions of source code must retain the above copyright notice, this</span>
<span class="c"># list of conditions and the following disclaimer.</span>
<span class="c">#</span>
<span class="c"># Redistributions in binary form must reproduce the above copyright notice, this</span>
<span class="c"># list of conditions and the following disclaimer in the documentation and/or</span>
<span class="c"># other materials provided with the distribution.</span>
<span class="c"># </span>
<span class="c"># Neither the name of the Purdue University nor the names of its contributors</span>
<span class="c"># may be used to endorse or promote products derived from this software without</span>
<span class="c"># specific prior written permission.</span>
<span class="c"># </span>
<span class="c"># THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;</span>
<span class="c"># AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<span class="c"># IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span>
<span class="c"># DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE</span>
<span class="c"># FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span>
<span class="c"># DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR</span>
<span class="c"># SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER</span>
<span class="c"># CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,</span>
<span class="c"># OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
<span class="c"># OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>

<span class="sd">&quot;&quot;&quot;Module to handle config file loading.&quot;&quot;&quot;</span>

<span class="n">__copyright__</span> <span class="o">=</span> <span class="s">&#39;Copyright (C) 2009, Purdue University&#39;</span>
<span class="n">__license__</span> <span class="o">=</span> <span class="s">&#39;BSD&#39;</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="s">&#39;#TRUNK#&#39;</span>


<span class="kn">import</span> <span class="nn">ConfigParser</span>
<span class="kn">import</span> <span class="nn">constants</span>
<span class="kn">import</span> <span class="nn">db_access</span>
<span class="kn">import</span> <span class="nn">errors</span>


<div class="viewcode-block" id="Config"><a class="viewcode-back" href="../../roster_core.html#roster_core.config.Config">[docs]</a><span class="k">class</span> <span class="nc">Config</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  <span class="sd">&quot;&quot;&quot;Abstracts a config file for Roster Core and Server&quot;&quot;&quot;</span>
  <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="o">=</span><span class="s">&#39;/etc/roster_server.conf&#39;</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Sets self.server, self.database, self.login and self.password from </span>
<span class="sd">    a config file or passed vriables.</span>

<span class="sd">    Inputs:</span>
<span class="sd">      file_name:	name of config file to parse</span>
<span class="sd">      db_server: name of database server</span>
<span class="sd">      db_database: name of database on server</span>
<span class="sd">      db_login: login name used to access the database</span>
<span class="sd">      db_passwd: password used to login to the database</span>

<span class="sd">    Raises:</span>
<span class="sd">      ConfigError: Could not read the file.</span>
<span class="sd">      ConfigError: Variable is not used</span>
<span class="sd">      ConfigError: Datatype is not supported</span>
<span class="sd">      ConfigError: Variable is missing in config file section</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">cp</span> <span class="o">=</span> <span class="n">ConfigParser</span><span class="o">.</span><span class="n">SafeConfigParser</span><span class="p">()</span>
    <span class="n">a</span> <span class="o">=</span> <span class="n">cp</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span>
    <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span> <span class="o">=</span> <span class="p">{}</span>
    <span class="bp">self</span><span class="o">.</span><span class="n">config_file_path</span> <span class="o">=</span> <span class="n">file_name</span>
    <span class="k">if</span><span class="p">(</span> <span class="n">a</span> <span class="o">==</span> <span class="p">[]</span> <span class="p">):</span>
      <span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">ConfigError</span><span class="p">(</span><span class="s">&#39;Could not read the file </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">file_name</span><span class="p">)</span>

    <span class="n">file_schema</span> <span class="o">=</span> <span class="n">constants</span><span class="o">.</span><span class="n">CONFIG_FILE_SCHEMA</span>

    <span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">file_schema</span><span class="p">:</span>
      <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="n">section</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
      <span class="k">if</span><span class="p">(</span> <span class="n">cp</span><span class="o">.</span><span class="n">has_section</span><span class="p">(</span><span class="n">section</span><span class="p">)</span> <span class="p">):</span>
        <span class="n">variables</span> <span class="o">=</span> <span class="n">file_schema</span><span class="p">[</span><span class="n">section</span><span class="p">]</span>
        <span class="n">file_variables</span> <span class="o">=</span> <span class="n">cp</span><span class="o">.</span><span class="n">options</span><span class="p">(</span><span class="n">section</span><span class="p">)</span>
        <span class="k">for</span> <span class="n">variable</span> <span class="ow">in</span> <span class="n">file_variables</span><span class="p">:</span>
          <span class="k">if</span><span class="p">(</span> <span class="n">variable</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">variables</span> <span class="p">):</span>
            <span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">ConfigError</span><span class="p">(</span><span class="s">&#39;Variable &quot;</span><span class="si">%s</span><span class="s">&quot; in &quot;</span><span class="si">%s</span><span class="s">&quot; is not used&#39;</span> <span class="o">%</span> <span class="p">(</span>
                                     <span class="n">variable</span><span class="p">,</span> <span class="n">file_name</span><span class="p">))</span>
        <span class="k">for</span> <span class="n">variable</span> <span class="ow">in</span> <span class="n">variables</span><span class="p">:</span>
          <span class="k">if</span><span class="p">(</span> <span class="n">variable</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">file_variables</span> <span class="p">):</span>
            <span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">ConfigError</span><span class="p">(</span><span class="s">&#39;Variable &quot;</span><span class="si">%s</span><span class="s">&quot; is missing in config file: &#39;</span>
                                     <span class="s">&#39;&quot;</span><span class="si">%s</span><span class="s">&quot;, in the &quot;</span><span class="si">%s</span><span class="s">&quot; section.&#39;</span> <span class="o">%</span> <span class="p">(</span> 
                                     <span class="n">variable</span><span class="p">,</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">section</span><span class="p">))</span>
          <span class="k">if</span><span class="p">(</span> <span class="n">variables</span><span class="p">[</span><span class="n">variable</span><span class="p">]</span> <span class="ow">is</span> <span class="s">&#39;str&#39;</span> <span class="p">):</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="n">section</span><span class="p">][</span><span class="n">variable</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
                <span class="n">cp</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">section</span><span class="p">,</span> <span class="n">variable</span><span class="p">))</span>
          <span class="k">elif</span><span class="p">(</span> <span class="n">variables</span><span class="p">[</span><span class="n">variable</span><span class="p">]</span> <span class="ow">is</span> <span class="s">&#39;int&#39;</span> <span class="p">):</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="n">section</span><span class="p">][</span><span class="n">variable</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
                <span class="n">cp</span><span class="o">.</span><span class="n">getint</span><span class="p">(</span><span class="n">section</span><span class="p">,</span> <span class="n">variable</span><span class="p">))</span>
          <span class="k">elif</span><span class="p">(</span> <span class="n">variables</span><span class="p">[</span><span class="n">variable</span><span class="p">]</span> <span class="ow">is</span> <span class="s">&#39;boolean&#39;</span> <span class="p">):</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="n">section</span><span class="p">][</span><span class="n">variable</span><span class="p">]</span> <span class="o">=</span> <span class="n">cp</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="n">section</span><span class="p">,</span>
                                                                <span class="n">variable</span><span class="p">)</span>
          <span class="k">elif</span><span class="p">(</span> <span class="n">variables</span><span class="p">[</span><span class="n">variable</span><span class="p">]</span> <span class="ow">is</span> <span class="s">&#39;float&#39;</span> <span class="p">):</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="n">section</span><span class="p">][</span><span class="n">variable</span><span class="p">]</span> <span class="o">=</span> <span class="n">cp</span><span class="o">.</span><span class="n">getfloat</span><span class="p">(</span><span class="n">section</span><span class="p">,</span> <span class="n">variable</span><span class="p">)</span>
          <span class="k">else</span><span class="p">:</span>
            <span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">ConfigError</span><span class="p">(</span><span class="s">&#39;DataType &quot;</span><span class="si">%s</span><span class="s">&quot; is not supported&#39;</span> <span class="o">%</span> <span class="p">(</span>
                                     <span class="n">variables</span><span class="p">[</span><span class="n">variable</span><span class="p">]))</span>

    <span class="k">if</span><span class="p">(</span> <span class="s">&#39;authentication_method&#39;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;credentials&#39;</span><span class="p">]</span> <span class="p">):</span>
      <span class="n">authentication_method</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;credentials&#39;</span><span class="p">][</span>
          <span class="s">&#39;authentication_method&#39;</span><span class="p">]</span>
      <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="n">authentication_method</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
      <span class="n">authentication_values</span> <span class="o">=</span> <span class="n">cp</span><span class="o">.</span><span class="n">items</span><span class="p">(</span><span class="n">authentication_method</span><span class="p">)</span>
      <span class="k">for</span> <span class="n">authentication_value</span> <span class="ow">in</span> <span class="n">authentication_values</span><span class="p">:</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="n">authentication_method</span><span class="p">][</span><span class="n">authentication_value</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(</span>
            <span class="n">authentication_value</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>

<div class="viewcode-block" id="Config.GetDb"><a class="viewcode-back" href="../../roster_core.html#roster_core.config.Config.GetDb">[docs]</a>  <span class="k">def</span> <span class="nf">GetDb</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a dbAccess instance.</span>

<span class="sd">    Outputs:</span>
<span class="sd">      dbAccess instance</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;server&#39;</span><span class="p">],</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;login&#39;</span><span class="p">],</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;passwd&#39;</span><span class="p">],</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;database&#39;</span><span class="p">],</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;big_lock_timeout&#39;</span><span class="p">],</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;big_lock_wait&#39;</span><span class="p">]]</span>
    <span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
    <span class="k">if</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;ssl&#39;</span><span class="p">]</span> <span class="p">):</span>
      <span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;ssl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">True</span>
      <span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;ssl_ca&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;ssl_ca&#39;</span><span class="p">]</span>
    <span class="k">if</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;db_debug&#39;</span><span class="p">]</span> <span class="p">):</span>
      <span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;db_debug&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;db_debug&#39;</span><span class="p">]</span>
      <span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;db_debug_log&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">[</span><span class="s">&#39;database&#39;</span><span class="p">][</span><span class="s">&#39;db_debug_log&#39;</span><span class="p">]</span>
    
    <span class="k">return</span> <span class="n">db_access</span><span class="o">.</span><span class="n">dbAccess</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>

<span class="c"># vi: set ai aw sw=2:</span></div></div>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../index.html">Roster Core v0.17 documentation</a> &raquo;</li>
          <li><a href="../index.html" >Module code</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Purdue University.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>